/*
 * Copyright (C) 2011 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.codemirror2_gwt.client;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * Overlay for codemirror's search cursor.
 *
 * @author Nikhil Singhal
 */
public final class SearchCursor extends JavaScriptObject {

  protected SearchCursor() { }

  /**
   * Search forward from the current position. The return value indicates whether a match was found.
   * If matching a regular expression, the return value will be the array returned by the match
   * method, in case you want to extract matched groups.
   */
  public native boolean findNext() /*-{
    return this.findNext() !== false;
  }-*/;

  /**
   * Search backward from the current position. The return value indicates whether a match was
   * found. If matching a regular expression, the return value will be the array returned by the
   * match method, in case you want to extract matched groups.
   */
  public native boolean findPrevious() /*-{
    return this.findPrevious() !== false;
  }-*/;

  /**
   * This is only valid when the last call to findNext or findPrevious did not return false.
   * This will return {@link Cursor} objects pointing at the start of the match.
   */
  public native Cursor getFrom() /*-{
    return this.from();
  }-*/;

  /**
   * This is only valid when the last call to findNext or findPrevious did not return false.
   * This will return {@link Cursor} objects pointing at the end of the match.
   */
  public native Cursor getTo() /*-{
    return this.to();
  }-*/;
}
